Crate bevy_ui

Expand description

This crate contains Bevy’s UI system, which can be used to create UI for both 2D and 3D games

Basic usage

Spawn UI elements with node_bundles::ButtonBundle, node_bundles::ImageBundle, [node_bundles::TextBundle] and node_bundles::NodeBundle This UI is laid out with the Flexbox layout model (see https://cssreference.io/flexbox/)

BackgroundColor
The background color of the node
CalculatedClip
The calculated clip of the node
CalculatedSize
The calculated size of the node
DefaultCameraView
DrawUiNode
ExtractedUiNode
ExtractedUiNodes
FlexSurface
Node
Describes the size of a UI node
NodeQuery
Main query for ui_focus_system
NodeQueryItem
Automatically generated WorldQuery item type for NodeQuery, returned when iterating over query results.
NodeQueryReadOnly
Automatically generated WorldQuery type for a read-only variant of NodeQuery.
NodeQueryReadOnlyItem
Automatically generated WorldQuery item type for NodeQueryReadOnly, returned when iterating over query results.
RelativeCursorPosition
A component storing the position of the mouse relative to the node, (0., 0.) being the top-left corner and (1., 1.) being the bottom-right If the mouse is not over the node, the value will go beyond the range of (0., 0.) to (1., 1.) A None value means that the cursor position is unknown.
SetUiTextureBindGroup
SetUiViewBindGroup
Size
A 2-dimensional area defined by a width and height.
Style
Describes the style of a UI node
TransparentUi
UiBatch
UiImage
The 2D texture displayed for this UI node
UiImageBindGroups
UiMeta
UiPassNode
UiPipeline
UiPipelineKey
UiPlugin
The basic plugin for Bevy UI
UiRect
A type which is commonly used to define positions, margins, paddings and borders.
UiScale
The current scale of the UI.
UiStack
The current UI stack, which contains all UI nodes ordered by their depth (back-to-front).

AlignContent
Defines how each line is aligned within the flexbox.
AlignItems
How items are aligned according to the cross axis
AlignSelf
How this item is aligned according to the cross axis. Overrides AlignItems.
Direction
Defines the text direction
Display
Whether to use a Flexbox layout model.
FlexDirection
Defines how flexbox items are ordered within a flexbox
FlexError
FlexWrap
Defines if flexbox items appear on a single line or on multiple lines
FocusPolicy
Describes whether the node should block interactions with lower nodes
Interaction
Describes what type of input interaction has occurred for a UI node.
JustifyContent
Defines how items are aligned according to the main axis
Overflow
Whether to show or hide overflowing items
PositionType
The strategy used to position this node
RenderUiSystem
UiSystem
The label enum labeling the types of systems in the Bevy UI
Val
An enum that describes possible types of value in flexbox layout options
ValArithmeticError
ZIndex
Indicates that this Node entity’s front-to-back ordering is not controlled solely by its location in the UI hierarchy. A node with a higher z-index will appear on top of other nodes with a lower z-index.